<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
                "http://www.w3.org/TR/REC-html40/loose.dtd">
<html>
<head>
  <title>Description of set_spectide</title>
  <meta name="keywords" content="set_spectide">
  <meta name="description" content="Setup spectral tides on the open boundary and dump a spectral file">
  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
  <meta name="generator" content="m2html v1.5 &copy; 2003-2005 Guillaume Flandin">
  <meta name="robots" content="index, follow">
  <link type="text/css" rel="stylesheet" href="../m2html.css">
</head>
<body>
<a name="_top"></a>
<div><a href="../index.html">Home</a> &gt;  <a href="index.html">fvcom_prepro</a> &gt; set_spectide.m</div>

<!--<table width="100%"><tr><td align="left"><a href="../index.html"><img alt="<" border="0" src="../left.png">&nbsp;Master index</a></td>
<td align="right"><a href="index.html">Index for fvcom_prepro&nbsp;<img alt=">" border="0" src="../right.png"></a></td></tr></table>-->

<h1>set_spectide
</h1>

<h2><a name="_name"></a>PURPOSE <a href="#_top"><img alt="^" border="0" src="../up.png"></a></h2>
<div class="box"><strong>Setup spectral tides on the open boundary and dump a spectral file</strong></div>

<h2><a name="_synopsis"></a>SYNOPSIS <a href="#_top"><img alt="^" border="0" src="../up.png"></a></h2>
<div class="box"><strong>function set_spectide(Mobj) </strong></div>

<h2><a name="_description"></a>DESCRIPTION <a href="#_top"><img alt="^" border="0" src="../up.png"></a></h2>
<div class="fragment"><pre class="comment"> Setup spectral tides on the open boundary and dump a spectral file  

 function set_spectide(Mobj)  

 DESCRIPTION:
    Setup spectral tides on the open boundary and dump a spectral file
    This is a USER DEFINED driver program for the FVCOM spectral tide
    It requires USER Modification to work 

 INPUT
    Mobj         = Matlab mesh object

 OUTPUT:

 EXAMPLE USAGE
    set_spectide(Mobj)

 Author(s):  
    Geoff Cowles (University of Massachusetts Dartmouth)

 Revision history
   
==============================================================================</pre></div>

<!-- crossreference -->
<h2><a name="_cross"></a>CROSS-REFERENCE INFORMATION <a href="#_top"><img alt="^" border="0" src="../up.png"></a></h2>
This function calls:
<ul style="list-style-image:url(../matlabicon.gif)">
<li><a href="write_FVCOM_spectide.html" class="code" title="function write_FVCOM_spectide(ObcNodes,Period,Phase,Amp,SpectralFile,MyTitle)">write_FVCOM_spectide</a>	Write an FVCOM spectral tidal elevation forcing file</li></ul>
This function is called by:
<ul style="list-style-image:url(../matlabicon.gif)">
<li><a href="example.html" class="code" title="">example</a>	example demonstrating reading in a 2DM file and constructing a model</li></ul>
<!-- crossreference -->



<h2><a name="_source"></a>SOURCE CODE <a href="#_top"><img alt="^" border="0" src="../up.png"></a></h2>
<div class="fragment"><pre>0001 <a name="_sub0" href="#_subfunctions" class="code">function set_spectide(Mobj)</a>
0002 
0003 <span class="comment">% Setup spectral tides on the open boundary and dump a spectral file</span>
0004 <span class="comment">%</span>
0005 <span class="comment">% function set_spectide(Mobj)</span>
0006 <span class="comment">%</span>
0007 <span class="comment">% DESCRIPTION:</span>
0008 <span class="comment">%    Setup spectral tides on the open boundary and dump a spectral file</span>
0009 <span class="comment">%    This is a USER DEFINED driver program for the FVCOM spectral tide</span>
0010 <span class="comment">%    It requires USER Modification to work</span>
0011 <span class="comment">%</span>
0012 <span class="comment">% INPUT</span>
0013 <span class="comment">%    Mobj         = Matlab mesh object</span>
0014 <span class="comment">%</span>
0015 <span class="comment">% OUTPUT:</span>
0016 <span class="comment">%</span>
0017 <span class="comment">% EXAMPLE USAGE</span>
0018 <span class="comment">%    set_spectide(Mobj)</span>
0019 <span class="comment">%</span>
0020 <span class="comment">% Author(s):</span>
0021 <span class="comment">%    Geoff Cowles (University of Massachusetts Dartmouth)</span>
0022 <span class="comment">%</span>
0023 <span class="comment">% Revision history</span>
0024 <span class="comment">%</span>
0025 <span class="comment">%==============================================================================</span>
0026 subname = <span class="string">'set_spectide'</span>;
0027 <span class="keyword">global</span> ftbverbose;
0028 <span class="keyword">if</span>(ftbverbose);
0029   fprintf(<span class="string">'\n'</span>)
0030   fprintf([<span class="string">'begin : '</span> subname <span class="string">'\n'</span>])
0031 <span class="keyword">end</span>;
0032 
0033 <span class="comment">%------------------------------------------------------------------------------</span>
0034 <span class="comment">% Set Constants</span>
0035 <span class="comment">%------------------------------------------------------------------------------</span>
0036 MyTitle = <span class="string">'spectral tide test'</span>;
0037 SpectralFile = <span class="string">'tst_spectide.nc'</span>;
0038 
0039 <span class="comment">%------------------------------------------------------------------------------</span>
0040 <span class="comment">% Set Component Periods</span>
0041 <span class="comment">%------------------------------------------------------------------------------</span>
0042 Components = {   <span class="string">'M2'</span>,    <span class="string">'N2'</span>,    <span class="string">'S2'</span>,   <span class="string">'O1'</span>,    <span class="string">'K1'</span>};
0043 Period     = [44714.16, 45570.05, 43200, 92949.63, 86164.09];
0044 
0045 <span class="comment">%------------------------------------------------------------------------------</span>
0046 <span class="comment">% Setup user defined phase and amplitude along the open boundaries</span>
0047 <span class="comment">% need to set:</span>
0048 <span class="comment">%   1.) Period - vector containing component period in seconds</span>
0049 <span class="comment">%   2.) Amp    - array of size [Nobcs, Ncomponents] containing amplitude in m</span>
0050 <span class="comment">%   3.) Phase  - array of size [Nobcs, Ncomponents] containing phase in degrees</span>
0051 <span class="comment">%------------------------------------------------------------------------------</span>
0052 nComps = 1;
0053 
0054 <span class="keyword">if</span>(Mobj.nObs==0)
0055     warning(<span class="string">'cannot setup spectral open boundary, there is no open boundary in the mesh struct'</span>)
0056     <span class="keyword">return</span>
0057 <span class="keyword">end</span>;
0058 
0059 cnt = 0;
0060 <span class="keyword">for</span> ob=1:Mobj.nObs
0061     nObcs = Mobj.nObcNodes(ob);
0062     <span class="keyword">for</span> j=1:nObcs
0063         cnt = cnt + 1;
0064         ObcNodes(cnt) = Mobj.obc_nodes(1,j);  <span class="comment">%set the open boundary nodes</span>
0065         <span class="keyword">for</span> i=1:nObcs
0066             <span class="keyword">if</span>(ob==1)
0067                 Amp(cnt,1:nComps) = [1.0];  
0068             <span class="keyword">else</span>
0069                 Amp(cnt,1:nComps) = [1.0];
0070             <span class="keyword">end</span>;
0071         <span class="keyword">end</span>;
0072 
0073         <span class="keyword">for</span> i=1:nObcs
0074             Phase(cnt,1:nComps) = [0.];
0075         <span class="keyword">end</span>;
0076     <span class="keyword">end</span>;
0077 <span class="keyword">end</span>;
0078 
0079 <span class="comment">%------------------------------------------------------------------------------</span>
0080 <span class="comment">% Dump a spectral tide file in NetCDF</span>
0081 <span class="comment">%------------------------------------------------------------------------------</span>
0082 <a href="write_FVCOM_spectide.html" class="code" title="function write_FVCOM_spectide(ObcNodes,Period,Phase,Amp,SpectralFile,MyTitle)">write_FVCOM_spectide</a>(ObcNodes,Period(1:nComps),Phase,Amp,SpectralFile,MyTitle)
0083 
0084 <span class="keyword">if</span>(ftbverbose); fprintf([<span class="string">'end   : '</span> subname <span class="string">'\n'</span>]);<span class="keyword">end</span>;</pre></div>
<hr><address>Generated on Wed 02-Nov-2011 21:58:00 by <strong><a href="http://www.artefact.tk/software/matlab/m2html/" title="Matlab Documentation in HTML">m2html</a></strong> &copy; 2005</address>
</body>
</html>